Interface ScriptValue

All Superinterfaces:
IPCObject
All Known Implementing Classes:
ScriptValueImpl

public interface ScriptValue extends IPCObject
Information provided by the PKI file:

    \class ScriptValue
    
    \brief ScriptValue provides functionality to convert this script Engines values to basic types.
    
    \example appWindow().getActiveFile().getScriptEngine().createScriptValueInt(1)
    
Author:
Auto-generated
  • Method Details

    • isBoolean

      boolean isBoolean()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a boolean, otherwise false.
          
          \return bool, true if this ScriptValue is a boolean, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isFunction

      boolean isFunction()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a function, otherwise false.
          
          \return bool, true if this ScriptValue is a function, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isNull

      boolean isNull()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is null, otherwise false.
          
          \return bool, true if this ScriptValue is null, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isNumber

      boolean isNumber()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a number, otherwise false.
          
          \return bool, true if this ScriptValue is a number, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isObject

      boolean isObject()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an object, otherwise false.
          
          \return bool, true if this ScriptValue is an object, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isUndefined

      boolean isUndefined()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is undefined, otherwise false.
          
          \return bool, true if this ScriptValue is undefined, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isValid

      boolean isValid()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is valid, otherwise false.
          
          \return bool, true if this ScriptValue is valid, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isString

      boolean isString()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is a string, otherwise false.
          
          \return bool, true if this ScriptValue is a string, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isError

      boolean isError()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an error, otherwise false.
          
          \return bool, true if this ScriptValue is an error, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • isArray

      boolean isArray()
      Information provided by the PKI file:
      
          \brief Returns true if this ScriptValue is an array, otherwise false.
          
          \return bool, true if this ScriptValue is an array, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • property

      ScriptValue property(String name)
      Information provided by the PKI file:
      
          \brief Returns the specified property.
          
          \param name, the name of the property of interest.
          
          \return ScriptValue, the ScriptValue object of the specified property.
          
              
      Parameters:
      name - Takes in a parameter of name
      Returns:
      ScriptValue Returns a ScriptValue
    • toBoolean

      boolean toBoolean()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to a boolean.
          
          \return bool, the value of the converted ScriptValue.
          
              
      Returns:
      boolean Returns a boolean
    • toInt32

      int toInt32()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to an integer.
          
          \return int, the value of the converted ScriptValue.
          
              
      Returns:
      int Returns a int
    • toString

      String toString()
      Information provided by the PKI file:
      
          \brief Converts the ScriptValue to a QString.
          
          \return QString, the value of the converted ScriptValue.
          
              
      Overrides:
      toString in class Object
      Returns:
      String Returns a String